docs: fix typos and copy-paste errors in stats TypeScript declarations#12482
Merged
Conversation
stdlib-bot
added
Statistics
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
- task: lint_filenames
status: passed
- task: lint_editorconfig
status: passed
- task: lint_markdown_pkg_readmes
status: na
- task: lint_markdown_docs
status: na
- task: lint_markdown
status: na
- task: lint_package_json
status: na
- task: lint_repl_help
status: na
- task: lint_javascript_src
status: na
- task: lint_javascript_cli
status: na
- task: lint_javascript_examples
status: na
- task: lint_javascript_tests
status: na
- task: lint_javascript_benchmarks
status: na
- task: lint_python
status: na
- task: lint_r
status: na
- task: lint_c_src
status: na
- task: lint_c_examples
status: na
- task: lint_c_benchmarks
status: na
- task: lint_c_tests_fixtures
status: na
- task: lint_shell
status: na
- task: lint_typescript_declarations
status: passed
- task: lint_typescript_tests
status: passed
- task: lint_license_headers
status: passed
---
Planeshifter
force-pushed
the
philipp/stats-ts-docs-fixes
branch
from
284f244 to
bd917b9
Compare
This was referenced Jun 3, 2026
Contributor
Coverage ReportNo coverage information available. |
kgryte
reviewed
Jun 3, 2026
| @@ -31,15 +31,15 @@ type Unary = ( x: number ) => number; | |||
| */ | |||
| interface LogPDF { | |||
| /** | |||
| * Evaluates the natural logarithm of the probability density function (PDF) for an inverse gamma distribution with shape parameter `alpha` and scale parameter `beta` at a value `x`. | |||
| * Evaluates the natural logarithm of the probability density function (PDF) for an inverse gamma distribution with shape parameter `alpha` and rate parameter `beta` at a value `x`. | |||
Member
There was a problem hiding this comment.
@Planeshifter I'm confused. In invgamma/cdf above, you changed scale to rate, and now in this package for invgamma/logpdf you are changing rate to scale. Which is it?
Member
There was a problem hiding this comment.
According to Wikipedia, this should be scale. There are several other packages in invgamma which also need updating.
Member
There was a problem hiding this comment.
kgryte
reviewed
Jun 3, 2026
kgryte
reviewed
Jun 3, 2026
kgryte
reviewed
Jun 3, 2026
kgryte
reviewed
Jun 3, 2026
Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Athan <kgryte@gmail.com>
kgryte
reviewed
Jun 3, 2026
Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Athan <kgryte@gmail.com>
…ocs/types/index.d.ts
…cs/types/index.d.ts
…yc/docs/types/index.d.ts
kgryte
reviewed
Jun 3, 2026
Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Athan <kgryte@gmail.com>
kgryte
reviewed
Jun 3, 2026
kgryte
reviewed
Jun 3, 2026
kgryte
reviewed
Jun 3, 2026
kgryte
reviewed
Jun 3, 2026
kgryte
reviewed
Jun 3, 2026
Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Athan <kgryte@gmail.com>
kgryte
approved these changes
Jun 3, 2026
Member
kgryte
left a comment
kgryte
left a comment
There was a problem hiding this comment.
LGTM after a fair amount of clean-up.
kgryte
added
the
Documentation
Member
|
As the CI failure is expected, I'll go ahead and merge. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request fixes documentation-only issues in hand-written TypeScript declaration files (
docs/types/index.d.ts) across thestatsnamespace, surfaced by a systematic audit of the namespace's.d.tsfiles. All changes are confined to comments (TSDoc summaries,@param/@returns/@throwstext,@exampleblocks, and## Notesprose); no function signatures, types, or exports were modified.Highlights:
b = < 0→b < 0, "an maximum support" → "and maximum support", "along roes" → "along rows").@examplereferenced the wrong distribution or operation (e.g.gumbel/logisticmgfsummaries naming the "Gamma distribution",kumaraswamylogpdfnaming the "Arcsine distribution",padjustdocumentingholmas "Hommel's method").@paramnames and descriptions with their signatures (e.g.mgf@param x→@param t;negative-binomialstatistic@param r"failures" → "successes";binomial/arcsinequantileprobability args).@exampleissues (pairedttestexample now passesy;var yredeclarations changed to reassignment; corrected// returnsannotations such as~-1.938→~-1.941).mgfblock-comment terminator alignment, Unicodeλ/σ→lambda/sigmain Notes).Note: this PR intentionally edits only the underlying package declaration files; the generated namespace-root aggregator
docs/types/index.d.tsfiles are not hand-edited and will regenerate from these sources. Findings that require actual declaration changes (parameter renames in signatures, type fixes, alogpdf→logpmfmethod rename, a missingdcorrelationexport, etc.) are intentionally excluded and will be submitted as separate per-package PRs.Related Issues
No.
Questions
No.
Other
No.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was prepared with Claude Code: an agent audited the
statsnamespace TypeScript declarations, and per-file agents applied the verified documentation-only fixes. Each finding was independently verified against the source file before editing. The changes were reviewed by myself prior to submission.@stdlib-js/reviewers